根据:请求ID,容器数据ID,批次ID等分页查询菜单商品容器数据;不加任何参数,则分页查询所有数据。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
POST /ListMenuData HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
PageNumber | Integer | FormData | 是 | 1 |
分页编号 |
PageSize | Integer | FormData | 是 | 20 |
分页大小 |
CreateRequestId | String | FormData | 否 | createRequestId |
请求id |
ProductContainerId | String | FormData | 否 | productContainerId |
商品容器id |
BatchId | String | FormData | 否 | batchId |
批次id |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Success | Boolean | true |
成功标志 |
Message | String | Success |
说明 |
Code | String | Success |
状态码 |
HttpStatusCode | Integer | 200 |
http状态码 |
RequestId | String | requestId |
请求ID |
TotalCount | Long | 120 |
数据总数 |
PageNumber | Integer | 1 |
页码数 |
PageSize | Integer | 20 |
页码大小 |
Data | Array of Data |
菜单商品模版数据 |
|
ProductContainerId | String | productContainerId |
菜单商品容器数据id-必填 |
BatchId | String | batchId |
菜单商品容器数据批次id-选填 |
ShopIdList | Array of String | shopId |
门店ID |
ShopGroupId | String | shopGroupId |
自定义门店组id(当shopIdList为空才生效)-选填 |
Type | String | top |
菜单商品容器数据类型(目前支持:top,morning,afternoon)-必填 |
Priority | Integer | 1 |
数据优先级,数值越高,优先级越大(默认为0)-选填 |
ProductCombineList | Array of ProductCombineList |
菜单商品容器数据-必填 |
|
Order | Integer | 1 |
组合顺序-必填 |
Name | String | 套餐 |
商品组名称-选填 |
ProductItemList | Array of ProductItemList |
商品组信息-必填 |
|
Order | Integer | 1 |
商品顺序-必填 |
ProductInfo | Object |
商品信息-必填 |
|
ProductId | String | productId |
商品编号(ID)-必填 |
ChineseName | String | 商品中文名称 |
商品中文名称-必填 |
EnglishName | String | 商品英文名称 |
商品英文名称-选填 |
Description | String | 描述 |
商品描述-选填 |
IconText | String | 新品 |
商品图标文字-选填 |
ProductType | String | 饮料-果汁 |
商品类型(数据格式:顶层类型-中层类型-底层类型)-选填 |
Temperature | String | normal |
商品冷热属性(hot,cold,normal,默认normal,不做特效展示)-选填 |
OriginalPrice | String | 12 |
商品原价-选填 |
CurrentPrice | String | 10 |
商品现价-选填 |
示例
请求示例
正常返回示例
JSON
格式
HTTP/1.1 200 OK
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Params.Illegal | The request parameters are invalid. | 请求入参非法 |
401 | Unauthorized | You are not authorized to perform this operation. | 未授权的请求 |
403 | Forbidden | This request is prohibited. | 请求被禁止 |
503 | Service.Unavailable | The service is unavailable. Please try again later. | 服务当前暂不可用,请稍后重试 |
访问错误中心查看更多错误码。